IGroup Interface

Represents an axis group. You can have up to 32 groups.

Inheritance Hierarchy

System.Object
System.ComponentModel.INotifyPropertyChanged
IntervalZero.KINGSTAR.Base.Class.IGroup

Namespace: IntervalZero.KINGSTAR.Base.Class

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

public interface IGroup : INotifyPropertyChanged

Public Interface IGroup Inherits INotifyPropertyChanged

The IGroup interface exposes the following members.

Methods

	Name	Description
	AddAxis	Adds an axis to a group.
	Halt	Commands a controlled motion stop.
	Inch	Commands a never-ending controlled motion at a specified velocity for an axis group with a maximum distance.
	Jog	Commands a never-ending controlled motion at a specified velocity for an axis group.
	MoveCircularAbsolute	Commands an interpolated circular movement on an axis group from the current position of the tool center point.
	MoveCircularAdditive	Commands an interpolated circular movement on an axis group from the current position of the tool center point.
	MoveCircularRelative	Commands an interpolated circular movement on an axis group from the current position of the tool center point.
	MoveDirectAbsolute	Commands a movement of an axis group to a specified absolute position in the specified coordinate system without taking care of how (on which path) the target position is reached.
	MoveDirectRelative	Commands a movement of an axis group to a relative position without taking care of how (on which path) the target position is reached.
	MoveHelicalAbsolute	Commands an interpolated helical movement on an axis group from the current position of the tool center point.
	MoveHelicalAdditive	Commands an interpolated helical movement on an axis group from the current position of the tool center point.
	MoveHelicalRelative	Commands an interpolated helical movement on an axis group from the current position of the tool center point.
	MoveLinearAbsolute	Commands an interpolated linear movement on an axis group from the current position of the tool center point to an absolute position in the specified coordinate system.
	MoveLinearAdditive	Commands an interpolated linear movement on an axis group from the current position of the tool center point to a relative position in the specified coordinate system.
	MoveLinearRelative	Commands an interpolated linear movement on an axis group from the current position of the tool center point to a relative position in the specified coordinate system.
	RemoveAllAxes	Removes all axes from a group.
	RemoveAxis	Removes an axis from a group.
	Reset	Changes the state GroupErrorStop to GroupStandstill by resetting all internal group-related errors.
	SetPositionOffset	Sets the position of all axes in a group without moving the axes.
	Stop	Commands a controlled motion stop and transfers the axis group to the state GroupStopping.
	UpdateConfiguration	Updates the values of the module by reading them from the Subsystem.
	WaitForTrigger	A group starts a new move when the trigger condition is met.

Properties

	Name	Description
	Axes	The list of axes in an axis group.
	AxesAcceleration	The actual acceleration in the selected coordinate system of an axis group.
	AxesPosition	The actual position in the selected coordinate system of an axis group.
	AxesVelocity	The actual velocity in the selected coordinate system of an axis group.
	Enable	Enables or disables an axis group.
	Error	The error that caused the group to go to the ErrorStop state.
	Override	Sets the override values for an axis group, and all methods that are working on that group.
	PathAcceleration	The current combined path acceleration of the tool center point.
	PathVelocity	The current combined path velocity of the tool center point.
	State	The state of an axis group according to the active grouped method.